Interoperability Toolkit
Acknowledgement Framework

Version: 2.0; Status: Final

ITKBusinessAcknowledgement Tabular View

Static model: ITKBusinessAcknowledgement - MCCI_RM020000GB02

Date: 07 December 2012 14:05:48 GMT
BusinessResponseMessage
Used by: 		Details of the acknowledgement.
id: II.NHS.IdentifierType2 [1..1] {M} This is the unique identifier for the message.

The Identifier Global datatype flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
creationTime: TS [1..1] {M} The time the Acknowledgement was created
interactionId: II.NPfIT.oid.required [1..1] {R}

The interaction identifier is the interaction identifier from the handlingSpecifications of the Distribution Envelope of the message being acknowledged.

The Identifier External datatype flavour is used to carry this information as follows:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.12
  • The extension attribute shall contain the interaction identifier from the handlingSpecifications of the distribution envelope of the message being acknowledged.
If no interaction identifier is available from the Distribution Envelope being acknowledged, a nullFlavor of "NA" should be used.
communicationFunction1 1..1 {M} (CommunicationFunctionRcv)
communicationFunction 1..1 {M} (CommunicationFunctionSnd)
acknowledgedBy3 1..1 {M} (Acknowledgement)
acknowledgedBy2 0..* {U} (ManifestItemAck)
controlActEvent1 1..1 {M} (ControlActEvent1)

CommunicationFunctionRcv
Used by: BusinessResponseMessage 		Details of the acknowledgement receiver.
typeCode: CS [1..1] {M < CD:CommunicationFunctionType = "RCV"} Indicates that the communication function being served is the receiver.

  • Fixed value "RCV"
entity 1..1 {M} (Entity)

CommunicationFunctionSnd
Used by: BusinessResponseMessage 		Details of the acknowledgement sender.
typeCode: CS [1..1] {M < CD:CommunicationFunctionType = "SND"} Indicates that the communication function being served is the sender.

  • Fixed value "SND"
entity 1..1 {M} (Entity)

Acknowledgement
Used by: BusinessResponseMessage 		The overall acknowledgement response for the message as a whole.
typeCode: CS [1..1] {M < V:AcknowledgementType CNE} { CNE:AcknowledgementType } A code identifying the action that has been taken on the message being acknowledged.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementType vocabulary.
If the receiving system processes the message successfully this code shall contain the value "AA" - Application Acknowledgement Accept

If the receiving system identifies a business issue or error which is reported in ControlActEvent.DetectedIssueEvent.code this code shall contain "AE" - Application Acknowledgement Error.

If the receiving system fails to process the message for reasons relating to the delivery of the message or it's structure, this code shall contain "AR" - Application Acknowledgement Reject
acknowledgementDetail 0..* {U} (AcknowledgementDetail1)
conveyingTransmission 1..1 {M} (AcknowledgedMessageIdentifier)

ManifestItemAck
Used by: BusinessResponseMessage

Each payload within an ITK Distribution Envelope may be acknowledged individually.

If no Manifest Item Acknowledgement is present for a given payload, then it's Acknowledgement typeCode is assumed to be the same as that for the overall message.
typeCode: CS [1..1] {M < V:AcknowledgementType CNE} { CNE:AcknowledgementType } A code identifying the action that has been taken on the manifest item being acknowledged.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementType vocabulary.
If the receiving system processes the message successfully this code shall contain the value "AA" - Application Acknowledgement Accept

If the receiving system identifies a business issue or error which is reported in ControlActEvent.DetectedIssueEvent.code this code shall contain "AE" - Application Acknowledgement Error.

If the receiving system fails to process the message for reasons relating to the delivery of the message or it's structure, this code shall contain "AR" - Application Acknowledgement Reject
acknowledgementDetail 0..* {U} (ManifestItemAckDetail )
conveyingTransmission 1..1 {M} (ManifestItem)

ControlActEvent1
Used by: BusinessResponseMessage 		The Control Act carries the business responses for the acknowledgement.
classCode: CS [1..1] {M = CACT}

Indicates this is a Control Act.

  • Fixed value "CACT"
moodCode: CS [1..1] {M = EVN}

Indicates that the control act mood is an event

  • Fixed value "EVN "
author 1..1 {M} ()

Entity
Used by: CommunicationFunctionSnd , CommunicationFunctionRcv

The entity from where the acknowledgement sender originates, or the entity receiving the acknowledgement.

The senders and receivers will both be represented by addresses. These will by default be ITK format addresses.
classCode: CS [1..1] {M = ENT}

Indicates that the sending sender and receiver are entities

  • Fixed value "ENT"
determinerCode: CS [1..1] {M = INSTANCE}

Indicates that the entity is a single instance

  • Fixed value "INSTANCE"
id: II.NHS.IdentifierType3 [1..1] {M} The address of the sender or receiver of the acknowledgement.
  • The root attribute shall contain an OID to represent the format of address used. The default ITK address format is represented by "2.16.840.1.113883.2.1.3.2.4.18.22"
  • The extension attribute shall contain the appropriate sending or receiving address.

AcknowledgementDetail1
Used by: Acknowledgement 		Details of the message acknowledgement.
typeCode: CS [1..1] {M < V:AcknowledgementDetailType CNE} { CNE:AcknowledgementDetailType } A code identifying the severity of the messaging problem that has been identified.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementDetailType vocabulary.
code: CV [1..1] {M < CD:ITKAcknowledgementExceptionCode}

A code identifying the specific problem being reported.

There is no prescribed code list for this attribute.

  • The code attribute shall contain a value from thecode system used
  • The codeSystem attribute shall contain the appropriate OID.
  • The displayName attribute is optional and may contain the textual description of the code.
text: ST [0..1] {U} A text attribute to contain additional information for the error being described.

AcknowledgedMessageIdentifier
Used by: Acknowledgement 		The identifier of the message being acknowledged
id: II.NHS.IdentifierType2 [1..1] {M} The unique identifier of the message that is being acknowledged. This is the identifier from the trackingId attribute of the Distribution Envelope of the message being acknowledged.

The Identifier Global datatype flavour is used to carry this information as follows:

  • A UUID is held in the root attribute
controlActEvent 0..1 {U} (ControlActEvent)

ControlActEvent
Used by: ManifestItem , AcknowledgedMessageIdentifier

The Control Act carries the business responses to the message which is being acknowledged or to an individual payload within the message.
classCode: CS [1..1] {M = CACT}

Indicates this is a Control Act.

  • Fixed value "CACT"
moodCode: CS [1..1] {M = EVN}

Indicates that the control act mood is an event

  • Fixed value "EVN "
author 0..1 {U} ()
reason 0..* {U} ()

[0..*]
Used by: ControlActEvent 		A link to a choice of authors for a detected business issue. If no authors are specified for the payloads, or for the received transmission, the mandatory author for the acknowledgement is assumed.
typeCode: CS [1..1] {M = AUT}

Indicates that the participation is an Author.

  • Fixed value "AUT"
roleTemplate 1..1 {U} (NPFIT-100020#Role)

[0..*]
Used by: ControlActEvent 		A pointer to detected issue
typeCode: CS [1..1] {M = RSON}

Indicates this is a Reason.

  • Fixed value "RSON"
detectedIssueEvent 1..1 {U} (DetectedIssueEvent)

DetectedIssueEvent
Used by: ControlActEvent

Details of the business issue or error that has been detected by the receiving system for this message, or manifest item.

A business issue or error is defined as being one that is related to the information conveyed in the manifest item or message as a whole, evaluated in context by the processing application.

Business issues may be described in terms of a code or as text, however, at least one of these attributes must be submitted.

classCode: CS [1..1] {M = ALRT}

Indicates this is an Alert.

  • Fixed value "ALRT"
moodCode: CS [1..1] {M = EVN}

Indicates that the detected issue mood is an event

  • Fixed value "EVN "
code: CD [0..1] {U < CD:ITKActDetectedIssueCode}

A code to represent the business issue detected in either the manifest item (payload) or the message as a whole.

  • The code attribute is required and shall contain a value from one of the code system used
  • The displayName attribute is optional and may contain the textual description of the code
  • The codeSystem attribute is required and shall contain an OID as appropriate.
  • The originalText sub element is optional and may contain the text used as the basis for the coding
  • The qualifier sub element is required and shall contain one of the qualifier codes identified under ITKDetectedIssueQualifier together with the appropriate OID.
Either a code or text description of the business issue must be submitted.
text: ST [0..1] {U}

Text to describe the business issue detected in either the manifest item (payload) or the message as a whole. This may be in support of the code attribute, or contain text in lieu of the code attribute.

Either a code or text description of the business issue must be submitted.


ManifestItemAckDetail
Used by: ManifestItemAck 		Details of the payload acknowledgement.
typeCode: CS [1..1] {M < V:AcknowledgementDetailType CNE} { CNE:AcknowledgementDetailType } A code identifying the severity of the messaging problem that has been identified.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the AcknowledgementDetailType vocabulary.
code: CV [1..1] {M < CD:ITKAcknowledgementExceptionCode}

A code identifying the specific problem being reported.

There is no prescribed code list for this attribute.

  • The code attribute shall contain a value from the code system used
  • The codeSystem attribute shall contain the appropriate OID.
  • The displayName attribute is optional and may contain the textual description of the code.
text: ST [0..1] {U} A text attribute to contain additional information for the error being described.

ManifestItem
Used by: ManifestItemAck 		The identifier of the payload being acknowledged
id: II.NHS.GenericType1 [1..1] {M} The identifier of the manifest item (payload) that is being acknowledged. This is the identifier from the payload.id attribute of the Distribution Envelope of the payload being acknowledged.

An Instance Identifier datatype flavour is used to carry this information as follows:

  • The manifest identifier is held in the root attribute
controlActEvent 0..1 {U} (ControlActEvent)

[0..*]
Used by: ControlActEvent1 		A link to the author of the acknowledgement.
typeCode: CS [1..1] {M = AUT}

Indicates that the participation is an Author.

  • Fixed value "AUT"
contextControlCode: CS [1..1] {M < CD:ContextControl = "OP"}

Specifies that the author of the acknowledgement propagates to the authorship of the response to the payload and acknowledged message. This hapens where no author is specified for a payload response, or a message response.

  • Fixed value = "OP"

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
roleTemplate 1..1 {U} NPFIT-100020#Role